Skip to main content

Inventory Reporting & Management

Use Inventory Reporting & Management to create detailed inventory reports of devices, rooms, and sites.

Examples

Inventory - Provide a View of the devices associated to a specific Account (Tenant). If an Account (Tenant) Id is provided as an URL parameter, it will be shown if you have access to the requested account.

All Inventory - Provide a View of all devices associated to all accounts you have access to.

Device Details - Clicking into any device from inventory dives provides the information applicable to a device and made available through Poly Lens.

Supported APIs

Custom Device Tags

APIDescriptionTypeRequired ArgumentsRequires Poly Lens Premium
addDeviceTag Attaches a new tag to a device and returns the list of all the tags for the device.Mutationtag, deviceIdNo
removeDeviceTag Removes the specified tag from a device and returns the list of all tags for the device.Mutationtag, deviceIdNo

Inventory Reporting

APIDescriptionTypeRequired ArgumentsRequires Poly Lens Premium
catalogModelsReturns the hardware product information for the products in the product catalog.Queryn/aNo
countDevices Returns the total number of devices the requesting user has permission to view, across all tenants that the user can access.Queryn/aNo
deviceAggregationsGrouping the devices based on their geographical location.Queryn/aNo
deviceSearch Searches for devices using query parameters. Supports pagination and finding results of more than 10K entries.
Note: The pageSize should be limited to 5000 entries or less (default 10). Also, pageSize parameter of subsequent page calls must be identical to the first, or an error will be returned.
Queryn/aNo
hardwareModel Hardware Model level details for an item in the product catalog.QueryhardwareModelIdNo

Notification Center

APIDescriptionTypeRequired Arguments
ncAddRecipient Adds a recipient who will receive notifications.MutationtenantId, input
ncConfirmEmail Confirms recipient's email address.MutationinviteId
ncCreateServiceNowWebhook Creates a new webhook in Poly Lens for ServiceNow.MutationtenantId, input
ncCreateTeamsWebhookForTenant Creates a new webhook in Poly Lens for Microsoft Teams.MutationtenantId
ncDeleteServiceNowWebhook Deletes a ServiceNow webhook.MutationtenantId, webhookId
ncDeleteTeamsWebhook Deletes a Microsoft Teams webhook.MutationtenantId, webhookId
ncDisableAction Disables notifications for an action.MutationtenantId, input
ncDisableServiceNowWebhook Disables a ServiceNow webhook.MutationtenantId, webhookId
ncDisableTeamsWebhook Disables a Microsoft Teams webhook.MutationtenantId, webhookId
ncDisableTenant Disables email notifications for an Account (Tenant).MutationtenantId
ncDisableUser Disables email notifications for users.MutationtenantId, userId
ncEnableAction Enables notifications for an action.MutationtenantId, input
ncEnableServiceNowWebhook Enables a ServiceNow webhook to start sending notifications to ServiceNow.MutationtenantId, webhookId
ncEnableTeamsWebhook Enables a Microsoft Teams webhook to start sending notifications to Microsoft Teams.MutationtenantId, webhookId
ncEnableTenant Enables email notifications for an Account (Tenant).MutationtenantId
ncEnableUser Enables email notifications for users.MutationtenantId, userId
ncPoly Returns details of all Poly notification configurations.QuerytenantId
ncRemoveRecipient Removes a recipient.MutationtenantId, input
ncReplaceRecipient Replaces a recipient.MutationtenantId, input
ncServiceNow Returns details of all configured ServiceNow webhooks.QuerytenantId
ncSetFrequency Sets notification frequency for an action.MutationtenantId, input
ncTeams Returns details of all configured Microsoft Teams webhooks.QuerytenantId
ncTestServiceNowWebhook Tests a ServiceNow webhook.MutationtenantId, input
ncTestServiceNowWebhookWithParams Tests a ServiceNow webhook with parameters.MutationtenantId, input
ncTestTeamsWebhook Tests a Microsoft Teams webhook.MutationtenantId, input
ncUnsubscribe Unsubscribes a recipient.MutationinviteId
ncUpdateServiceNowActionConfiguration Updates action configuration of a ServiceNow webhook.MutationtenantId, input
ncUpdateServiceNowWebhook Updates a ServiceNow webhook.MutationtenantId, webhookId, input
ncUpdateTeamsWebhook Updates a Microsoft Teams webhook.MutationtenantId, webhookId, input
ncUpdateWebhookActionConfiguration Updates action configuration of a Microsoft Teams webhook.MutationtenantId, input
notificationCenter Enables Account (Tenant) admin or device manager to enable and configure notifications for events that occur in Poly Lens.QuerytenantId

Room & Site Management

APIDescriptionTypeRequired ArgumentsRequires Poly Lens Premium
deleteRooms Deletes an existing room or sets of rooms.MutationtenantId, idsNo
deleteSites Deletes an existing site or set of sites.MutationtenantId, idsNo
room Gets detailed data for a specified room.QueryroomIdNo
roomData Retrieves room data for a specified Account (Tenant).QuerytenantIdNo
site Gets the geographical location of the device.QuerysiteIdNo
siteData Retrieves site data for a specified Account (Tenant).QuerytenantIdNo
switchSite Switches a room to another site.MutationtenantId, siteId, roomIdNo
upsertRoomCreates a new room or updates an existing room if applicable.MutationtenantId, siteIdNo
upsertSite Creates a new site or updates an existing site if applicable.MutationtenantId, nameNo

Subnet Management

APIDescriptionTypeRequired ArgumentsRequires Poly Lens Premium
createSubnetRule Creates a new subnet rule.MutationsiteId, publicCidrNo
deleteSubnetRuleDeletes an existing subnet rule.MutationruleIdNo
getSubnetRules Get subnet rules for a given site.QuerysiteIdNo
getSubnetRuleValidity Check if site subnet rules are valid.QuerytenantId, siteId, publicCidrNo
updateSubnetRuleUpdates an existing subnet rule.MutationpublicCidr, ruleIdNo